Skip to content

Send initial message for certain zwave_js ws subscriptions#71723

Merged
raman325 merged 3 commits intohome-assistant:devfrom
raman325:ws_msg
May 12, 2022
Merged

Send initial message for certain zwave_js ws subscriptions#71723
raman325 merged 3 commits intohome-assistant:devfrom
raman325:ws_msg

Conversation

@raman325
Copy link
Copy Markdown
Contributor

@raman325 raman325 commented May 12, 2022

Proposed change

Instead of sending a result with initial data for certain zwave_js WS API commands, we now send the initial data as a message so that it can properly be consumed by the UI. Tested in home-assistant/frontend#12668.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@raman325 raman325 requested a review from a team as a code owner May 12, 2022 06:36
@probot-home-assistant
Copy link
Copy Markdown

Hey there @home-assistant/z-wave, mind taking a look at this pull request as it has been labeled with an integration (zwave_js) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@MartinHjelmare
Copy link
Copy Markdown
Member

Why is this change needed?

@raman325
Copy link
Copy Markdown
Contributor Author

raman325 commented May 12, 2022

When we call these commands to subscribe to them, we are not getting the initial result. There may be a way to get it, but I found in testing that if instead of sending the initial data that we need to populate the initial state in the result and instead send it as an event, the frontend receives it and everything works correctly

@raman325 raman325 merged commit 0d69adb into home-assistant:dev May 12, 2022
@raman325 raman325 deleted the ws_msg branch May 12, 2022 07:07
@github-actions github-actions bot locked and limited conversation to collaborators May 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants